home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / palette tools / lockcolors / lockcolors.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  10KB  |  231 lines
  1. @DATABASE "Default"
  2. @NODE "MAIN" "LockColors Documentation"
  3. @TOC "MAIN"
  4.     Welcome to the AmigaGuide
  5.  manual for LockColors.
  6.     @{" Distibution  " LINK "Dist"}        Legal issues.
  7.     @{" Requirements " LINK "Requirements"}        What you need to run LockColors.
  8.     @{" Introduction " LINK "Intro"}        What does it do, exactly?
  9.     @{" Installation " LINK "Install"}        How to install LockColors.
  10.     @{" Tooltypes    " LINK "Tool"}        Customize LockColors.
  11.     @{" Usage        " LINK "Usage"}        Which gadgets to press.
  12.     @{" History      " LINK "Hist"}        The lifecycle of LockColors.
  13.     @{" Bugs         " LINK "Bugs"}        That is: Features.
  14.     @{" Future       " LINK "Future"}        Devlopement plans.
  15.     @{" Thanks       " LINK "Thanks"}        The people helping devlopement.
  16.     @{" Author       " LINK "Author"}        Snail- and email addresses etc.
  17. @ENDNODE
  18. @NODE "Dist" "Distribution"
  19. @TOC "MAIN"
  20. Distribution
  21. ~~~~~~~~~~~~
  22.     LockColors is 
  23. 1994 Torgeir Hovden. 
  24.     LockColors is released as CardWare. So if you like LockColors, 
  25.     and live somewhere exiting, please send me a postcard.
  26.     The archive you just unpacked may be freely distributed, but
  27.     you may not charge any money for it, except distribution
  28.     costs (diskettes, postage etc.)
  29.     The author can not be blamed for any damage caused by
  30.     LockColors. Use it on your own risk.
  31. @ENDNODE
  32. @NODE "Requirements" "Requirements"
  33. @TOC "MAIN"
  34. Requirements
  35. ~~~~~~~~~~~~
  36.     Any public screen on your Amiga.
  37.     LockColors uses OS 3.0+ specific system calls. Thus, version
  38.     39 or higher of the operating system is required. To be
  39.     honest, I really don't know what happens if you try to run
  40.     this on systems <39, and for all I know your system may very
  41.     well GURU. 
  42.     On systems fitted with os >=39, LockColors has proved to be 
  43.     very stable, and it has been tested with both Enforcer and 
  44.     Mungwall.
  45. @ENDNODE
  46. @NODE "Intro" "Introduction"
  47. @TOC "MAIN"
  48. Introduction
  49. ~~~~~~~~~~~~
  50.     Have you ever wanted a 256 color screen, use 3 bitplane
  51.     MagicWb icons AND make the whole thing look right?
  52.     Well, now you can, with LockColors.
  53.     LockColors is a commodity that gives you total (well almost)
  54.     over the system palette on Amiga's fitted with OS3.0 or
  55.     higher. It lets the user customize the palette and then
  56.     lock the pens, not permitting any other (OS3.0+ compliant)
  57.     program to change them. The locks are either exclusive or
  58.     shared (user selectable).
  59.     LockColors automatically senses when the Workbench is to be
  60.     reset, and lock all the colors selected on the new screen.
  61.     LockColors even closes its window automatically when
  62.     the Workbench screen is to be reset.
  63.     I thought use of LockColors only made sense only on screens
  64.     >8 colors. I was wrong. Users have informed me that LockColors
  65.     is the only way to monitor which pens are free or locked. So,
  66.     this version supports any screendepth.
  67. @ENDNODE
  68. @NODE "Install" "Installation"
  69. @TOC "MAIN"
  70. Installation
  71. ~~~~~~~~~~~~
  72.     Just copy LockColors to where you want it (or drag the
  73.     icon). The WbStartup drawer is a good start. It may
  74.     be a good idea to keep this documentation also.
  75. @ENDNODE
  76. @NODE "Tool" "ToolTypes"
  77. @TOC "MAIN"
  78. ToolTypes
  79. ~~~~~~~~~
  80.     DONOTWAIT           For Workbench when starting LockColors
  81.                         from the WbStartup drawer.
  82.     CX_POPUP            Should the GUI appair when you run first
  83.                         LockColors? Defaults to YES.
  84.     CX_PRIORITY         Priority of the CxHandler of LockColors.
  85.                         Defaults to 0.
  86.     CX_POPKEY           Hotkey to show GUI. Defaults to lalt l.
  87.     CFG                 Name of Configurationfile. Defaults to
  88.                         S:LockColors.cfg
  89.     PUBSCREEN           Name of the public screen to open on.
  90.                         Defaults to Workbench.
  91.     MAXSECS             Maximum time in seconds to wait for a
  92.                         screenreset when Workbench requests a
  93.                         reset. If the screenreset is canceled
  94.                         for any reason, LockColors will sit
  95.                         idle for maximum MAXSECS seconds.
  96.                         Defaults to 30.
  97.     LOCK                Type of lock for LockColors to use.
  98.                         Choose between Exclusive and Shared.
  99.                         Defaults to Exclusive (recommended).
  100.     These tooltypes may be either used from the CLI or as icon
  101.     tooltypes. When used from the CLI, see @{"Bugs" LINK "Bugs"}.
  102. @ENDNODE
  103. @NODE "Usage" "Usage"
  104. @TOC "MAIN"
  105. Usage
  106. ~~~~~
  107.     Well, this shouldn't be too hard. The GUI is simple and easy
  108.     to use. Just press the buttons and see what happens.
  109.     When the cyclegadget is disabled, it means that the actual 
  110.     pen is already locked by some other application (typically 
  111.     Workbench). Note that pens 0-3 (and the last 4 pens on screens 
  112.     with more than 4 colors) is always locked by Workbench. You 
  113.     may not alter already locked pens, thus disabled gadgets.
  114.     From LockColors 1.1, you may not alter free pens either.
  115.     Lock the pens first. This is to prevent users to 'forget' to
  116.     lock the pens, and prevents loosing configured pens.
  117.     Choosing Locked on the cyclegadget causes LockColors to
  118.     lock the current color, so that it may not be changed
  119.     (well, actually, LockColors can change it...) by a
  120.     V39 compliant application.
  121.     If some of the pens you have locked are already locked some
  122.     other time LockColors is run, the definitions is simply
  123.     ignored, until the required pens are available (typically
  124.     after a screenreset).
  125. NOTES:
  126.     Selecting SAVE makes LockColors save the current
  127.     setup, and then closes the window while still remaining
  128.     active. Selecting QUIT unlocks all pens obtained by
  129.     LockColors, and resets to the original palette.
  130.     If you have chosen the Shared locktype, some colors may
  131.     look awful after quiting LockColors, because other 
  132.     applications may have obtained one of the colors while 
  133.     LockColors was running.
  134.     Use Exclusive lock if this is a problem.
  135. Hints:
  136.     If you use MagicWb, the icons are 3 bitplanes deep. Because
  137.     Workbench remaps the palette for deeper screens (to make
  138.     complement right), the icons look really ugly. With
  139.     LockColors you just copy the last 4 colors to color 5-8,
  140.     locks these colors and whoila! The icons gets right every
  141.     time!
  142. @ENDNODE
  143. @NODE "Hist" "History"
  144. @TOC "MAIN"
  145. History
  146. ~~~~~~~
  147.     V0.9 -  Used a BYTE as pennumber. Caused LockColors to
  148.             crash when used on a 256 color WorkBench (negative
  149.             indexes in my colortable...). Fixed.
  150.     V1.0 -  Intitial release. Released 16/09-94.
  151.     V1.1 -  Released 7/10-94.
  152.          -  Speedup. Does not GetRGB32() for ALL the colors
  153.             when you click a color in the editor, just the
  154.             color needed.
  155.          
  156.          -  Does not prevent your Workbench to close anymore.
  157.             LockColors even closes it's window when Workbench
  158.             tries to close the screen. Feature is only available
  159.             on the Workbenchscreen.
  160.          -  Does not erase settings for a deeper screen than
  161.             the screen you are currently using.
  162.          
  163.          -  Now opens happily on screens <16 colors.
  164.          -  Window position made non-static, and saved in the
  165.             configurationfile.
  166.          
  167.          -  LockColors now requires a color to be locked before
  168.             the user can modify it. This means that:
  169.                 
  170.                 -   Copying a color to a free pen automatically
  171.                     locks it.
  172.                 -   Swapping two colors lock the colors involved.
  173.          
  174.          -  Fixed case insensitive check of the CX_POPUP tooltype.
  175.             Only "NO" was allowed, for instance "No" would cause 
  176.             the GUI to open.
  177.          -  PUBSCREEN tooltype allows LockColors to open on any
  178.             public screen.
  179.          -  LOCK tooltype allows selection between exclusive and
  180.             shared locks.
  181.          
  182.          -  MAXSECS tooltype specifies the maximum waittime in
  183.             seconds when Workbench requests a screen reset.
  184.          
  185.          -  Added NEWLOOK menus.
  186.             
  187. @ENDNODE
  188. @NODE "Bugs" "Features"
  189. @TOC "MAIN"
  190. Features
  191. ~~~~~~~~
  192. -   Uses topaz 8 for the sliders. Should have been using the
  193.     Screenfont. Sorry!
  194. -   Does not give you any hint on syntax when used from the CLI.
  195.     May be fixed if anyone really needs it.
  196. -   LockColors assumes 256 levels of intensity for each
  197.     colorelement (r g & b), but this shouldn't cause any major
  198.     problems. If you run LockColors on an OCS/ECS Amiga, compute
  199.     as follows: Myintesity=Shownidensity DIV 16  :-)
  200.     I haven't found any other undocumented features (bugs), but
  201.     if you find some, please let me know.
  202. @ENDNODE
  203. @NODE "Future" "Future"
  204. @TOC "MAIN"
  205. Future
  206. ~~~~~~
  207. -   Bugfixes.
  208. -   Any ideas????
  209. @ENDNODE
  210. @NODE "Thanks" "Thanks"
  211. @TOC "MAIN"
  212. Thank you
  213. ~~~~~~~~~
  214.     I would like to thank the people who have mailed me suggestions
  215.     to make LockColors better:
  216.     Harald Kunze
  217.     AJ Meyer
  218.     Edmund Vermeulen
  219.     THANKS!
  220. @ENDNODE
  221. @NODE "Author" "Author"
  222. @TOC "MAIN"
  223. Author
  224. ~~~~~~
  225. Snailmail:      Torgeir Hovden
  226.                 Moholt Alle 20-62
  227.                 N-7035 TRONDHEIM
  228.                 NORWAY
  229. email:          hovden@idt.unit.no
  230. @ENDNODE
  231.